home *** CD-ROM | disk | FTP | other *** search
/ Ham Radio 2000 / Ham Radio 2000.iso / ham2000 / bbs / m9filter / m1filter.eng < prev    next >
Text File  |  1993-10-09  |  4KB  |  103 lines
  1.  
  2.            Documentation file for (c)M1FILTER.EXE
  3.             By Bjorn Hallgren <SM6GQW>
  4.                   Version 0.1
  5.  
  6.  
  7.       Unregistered version of this software is HamWare. A registered
  8.       version of this software may only be copied as a personal backup.
  9.  
  10.       The unregistered version may be freely distributed in its original
  11.       form. You may not add or subtract any part of the original package.
  12.  
  13.       Description of M1FILTER(c).
  14.       The program runs directly under FBB version 5.15 and is called auto-
  15.       matically every time text is saved to disk. Information is given by
  16.       FBB where to find the file, status (P/B/A/T), receiver and sender.
  17.       The receiver refers to the TO-field.
  18.  
  19.       M1FILTER(c) reads the text and compares it with control data locat-
  20.       ed in a file called M1FILTER.WRD. When data fits with the specifi-
  21.       cations in M1FILTER.WRD then the program will generate an "exitcode" 
  22.       to FBB telling which status the text will be marked with. Different
  23.       status will be given depending on wether the text is a bulletin, 
  24.       personal mail, verification (ACK:) or a NTS-message. (The NTS-func-
  25.       tion is not yet implemented).
  26.  
  27.       Using the program in this way gives the sysop the flexibility to
  28.       locally configure the function at his own BBS.
  29.  
  30.       If you want to log what M1FILTER(c) is doing, then this can be done
  31.       by adding a line to M1FILTER.WRD. The logfile (M1FILTER.LOG) will be
  32.       created and will reside in the same subdirectory as the M1FILTER.EXE.
  33.  
  34.       Install.
  35.       If there is no other filterprogram in use then the installation will
  36.       be as follows: Rename M1FILTER.EXE to M_FILTER.EXE and M1FILTER.WRD
  37.       to M_FILTER.WRD. Locate both files to the FBB subdirectory BIN.
  38.       Next time you start the FBB, M_FILTER.exe will be recognized by the
  39.       BBS program and it will start to work automatically.
  40.  
  41.       If you already use a M_FILTER.EXE then, normally, there can not
  42.       be a second filter program running at the same time. To come
  43.       around this limitation I have written a small piece of software 
  44.       called M_FILTER.EXE which will replace the original M_FILTER.EXE.
  45.       The program is controlled through M_FILTER.CFG which contains
  46.       information on all filter programs you would like to use. The
  47.       program then executes each and every filter in chronological
  48.       order. For specific information read the M_FILTER.EXE documen-
  49.       tation. In most cases there is a M_FILTER which belongs to AUTO7P.
  50.       This one as well as M1FILTER(c) can be put in any subdirectory.
  51.  
  52.       M1FILTER.WRD contains the different words which the program is
  53.       searching for.
  54.  
  55.       Below you will find an example .WRD file
  56.  
  57. ##########################################
  58. #  Filterfile for M1FILTER(c) by SM6GQW  #
  59. ##########################################
  60. #
  61. # Comments shall begin with a # as the first sign.
  62. # Minimize comments as the program reads all put into the .WRD file
  63. #
  64. # Only capital ASCII signs are allowed.
  65. # Only single space strokes are allowed.
  66. # It is impossible to search for MAYBE   NOT. The filter reads this as
  67. # MAYBE NOT.
  68. # The unregistered version of this filter allows a maximum of 5 lines.
  69. # The registered version allows 10 search lines. A Sysop running a HF-
  70. # BBS will be granted more lines.
  71. # Anyone trying to modify the program will be hit by severe problems. One
  72. # of these problems is trashed datafiles.
  73. #
  74. S = Start logging what M1FILTER actually have done.
  75. H B @ALLE
  76. H B @ ALLE
  77. A B HITLER
  78. H B GO_7+.
  79. H P GO_7+.
  80. #
  81. #  M1FILTER to FBB exitcode: (This information will be written to
  82. #  the logfile.
  83. #  0 : Message is recorded
  84. #  1 : Message is killed    (status = K).
  85. #  2 : Message is archived  (status = A).
  86. #  3 : Message is held      (status = H).
  87. # EOF
  88.  
  89.    Suggestions and bug reports are much welcomed as well as wish lists
  90.    describeing improvements or "add-on" functions. There will be two 
  91.    different versions released. The unregistered version (standard).
  92.    The registered version with extended functions. Sysops running HF-
  93.    BBS:es will, upon request, receive the program with greatly enhanced
  94.    possibilities to lock out unwanted words.
  95.  
  96.    There is no fee. The author just asks for a picture postcard sent to
  97.    him at his home adress. QSL-cards via bureau does not count!!
  98.  
  99.    Bjorn Hallgren
  100.    Syster Ainas gata 3
  101.    S-413 23 Gothenburg
  102.    Sweden
  103.